Soy bastante nuevo en JS y JS Doc y tenía una pregunta sobre parámetros opcionales.
Imagina esta función
/** * @param {string} [param1] * @param {string} [param2] */ const foo= (){...}Como dice JSDoc, un parámetro opcional es así
/** * @param {string} [somebody] - Somebody's name. */¿Hay alguna forma, con mi ejemplo, de definir 2 parámetros opcionales pero se requiere al menos uno? (Si se establece param1, no se establece param2 y si se establece param2, no se establece param1).
Gracias por la ayuda.
Los corchetes alrededor del nombre del parámetro significan que es opcional. Para que sea obligatorio, quite los corchetes.
/** * @param {string} param1 - required * @param {string} [param2] - optional */ const foo= (){...}También podría usar Typescript, para un sistema de tipos más robusto.
const foo = (param1: string, param2?: string); Is there any way, with my example, to define 2 optional parameters but at least one is required ?(If param1 is set, param2 is not and if param2 is set, param1 is not).
Para resolver este problema, puede definir múltiples sobrecargas de funciones.
function foo(email:string); function foo(username:string){ if(username) return "Used username overlaod"; if(email) return "Used email overload"; }Para JSDoc es más difícil. Se ve como esto:
/** * * @constructor * @param {string} username * * @constructor * @param {string} email */ function foo(value) { // ... }Recomendaría usar TS sobre JSDoc.